Breaking v0.17.0 release - update for Agent-Friendly Docs Spec 0.5.0#66
Merged
Breaking v0.17.0 release - update for Agent-Friendly Docs Spec 0.5.0#66
Conversation
Strip 'style' and 'script' tags in HTML
Rename `llms-txt-freshness` to `llms-txt-coverage`, plus enhancements
Split 'llms-txt-directive' into 'html' and 'md' variants
…bility Single-page scoring reliability and run-level diagnostics
…udience-segmentation Handle intentional audience segmentation in 'markdown-content-parity'
Add shared validation module for CLI and library consumers
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings afdocs from spec v0.3.0 (22 checks) to v0.5.0 (23 checks) across 5 sub-PRs. This is a breaking release: check IDs renamed, check split, JSON output schema changed, scoring behavior changed.
PR 1: Strip
<script>and<style>in htmlToMarkdown (#61)Foundation change. Strips script/style elements before HTML-to-markdown conversion, fixing inflated page sizes and
content-start-positionmeasurements to match updates in Claude Code.PR 2: Rename
llms-txt-freshness→llms-txt-coverage+ curation + omitted subtrees (#62)Renames check ID. Adds configurable thresholds (
--coverage-pass-threshold,--coverage-warn-threshold), exclusion patterns (--coverage-exclusions), and omitted subtree handling for progressive disclosure sites.PR 3: Split
llms-txt-directive→llms-txt-directive-html+llms-txt-directive-md(#63)Splits one check into two. HTML check searches the DOM (stripping nav/script/style); markdown check probes
.mdendpoints. Newmarkdown-partially-discoverablediagnostic. Check count 22 → 23, max raw score 126 → 130.PR 4: Single-page scoring reliability (#64)
Adds
scoreDisplayMode(numeric|notApplicable) to check scores. Page-level checks get N/A when fewer than 5 pages discovered. Null category scores. Four new diagnostics:single-page-sample,cross-origin-llms-txt,gzipped-sitemap-skipped,rate-limiting-severe.PR 5:
markdown-content-parityaudience segmentation (#65)Adds
data-markdown-ignoreHTML attribute convention, configurable parity thresholds (--parity-pass-threshold,--parity-warn-threshold), custom CSS exclusion selectors (--parity-exclusions). Config validation for YAML exclusion arrays.Breaking changes for consumers
Check IDs:
llms-txt-freshness→llms-txt-coveragellms-txt-directive→llms-txt-directive-html+llms-txt-directive-mdJSON output schema:
CheckScorehas new required fieldscoreDisplayModeCategoryScore.scoreandgradecan benullReportResulthas new optional fieldstestedPagesandsamplingStrategymarkdown-content-paritydetails has new optional fields:segmentationElementsStripped,parityPassThreshold,parityWarnThresholdllms-txt-coveragedetails shape changed (new fields for thresholds, exclusions, omitted subtrees)llms-txt-links-resolvedetailscrossOriginhas newdominantOriginfieldmarkdown-partially-discoverable,single-page-sample,cross-origin-llms-txt,gzipped-sitemap-skipped,rate-limiting-severeScoring:
evaluateDiagnosticsrequires second argument (ReportResult)rendering-strategyandauth-gate-detectionscore caps skip N/A checksResolution text:
New
CheckOptionsfields (non-breaking, all optional with defaults):coveragePassThreshold,coverageWarnThreshold,coverageExclusionsparityPassThreshold,parityWarnThreshold,parityExclusionsllmsTxtUrl954 tests, lint clean, build clean.
Outstanding items before merge to main
Release prep:
src/constants.tsspec URL/version reference (v0.3.0 → v0.5.0)README.mdspec version and check count (22 → 23)Smoke tests:
npx afdocs check https://docs.anthropic.com -- scorecard output, 23 checks, correct IDsnpx afdocs check https://docs.anthropic.com --format json --score-- verify new check IDs present, old IDs absentnpx afdocs check <mintlify-site>-- verifyllms-txt-directive-htmlandllms-txt-directive-mdreport independentlynpx afdocs check <site> --coverage-pass-threshold 0 --coverage-warn-threshold 0-- verify informational modenpx afdocs check <site> --parity-pass-threshold 0 --parity-warn-threshold 0-- verify informational modenpx afdocs check <site> --sampling none-- verify single-page N/A behavior for page-level checksparityExclusionsandcoverageExclusionsDocs site: